pstree.remy

What is pstree.remy?

The pstree.remy npm package is used to retrieve the process tree of a given PID (Process ID) in a Node.js environment. It is particularly useful for debugging and monitoring purposes, allowing developers to understand the hierarchy and relationships between processes.

What are pstree.remy's main functionalities?

Retrieve Process Tree

This feature allows you to retrieve the process tree of the current process. The code sample demonstrates how to use the pstree function to get the children of the current process and log them to the console.

const pstree = require('pstree.remy');

pstree(process.pid, (err, children) => {
  if (err) {
    console.error(err);
  } else {
    console.log(children);
  }
});

Retrieve Process Tree with Signal

This feature allows you to retrieve the process tree and send a signal to each process in the tree. The code sample demonstrates how to use the pstree function with a signal option to send a SIGTERM signal to each child process.

const pstree = require('pstree.remy');

pstree(process.pid, { signal: 'SIGTERM' }, (err, children) => {
  if (err) {
    console.error(err);
  } else {
    console.log(children);
  }
});

Other packages similar to pstree.remy

ps-tree

The ps-tree package is another Node.js module that retrieves the process tree of a given PID. It is similar to pstree.remy but offers additional options for filtering and formatting the output. Compared to pstree.remy, ps-tree provides more flexibility in terms of customization.

tree-kill

The tree-kill package is used to kill a process and all its child processes. While it does not provide the process tree itself, it is useful for managing and terminating process hierarchies. It is more focused on process termination compared to pstree.remy, which is more about retrieving process information.

README

pstree.remy

Cross platform ps-tree (including unix flavours without ps)

Installation

npm install pstree.remy

Usage

const psTree = psTree require('pstree.remy');

psTree(PID, (err, pids) => {
  if (err) {
    console.error(err);
  }
  console.log(pids)
});

console.log(psTree.hasPS
  ? "This platform has the ps shell command"
  : "This platform does not have the ps shell command");